Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Footnotes implementation #178

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Footnotes implementation #178

wants to merge 4 commits into from

Conversation

panrus
Copy link

@panrus panrus commented Jan 20, 2021

To create a footnote reference, add a caret and an identifier inside brackets ([^1]).
Add the footnote using another caret and number inside brackets with a colon and text ([^1]: My footnote.). You don’t have to put footnotes at the end of the document. You can put them anywhere.

Here is an example:

The implementation focus is to be fast (see benchmark) and extensible [^1]

[^1]: See [benchmark](https://github.com/kzykhys/Markbench#readme).

@samwilson
Copy link

It'd be great to have footnote support!

There's a typo in the test filenames by the way, which is why the tests are passing.

Note that there's a MarkdownExtra test case here:
https://github.com/michelf/php-markdown/blob/lib/test/resources/php-markdown-extra.mdtest/Footnotes.text
Maybe it could be used verbatim, to ensure compatibility with that project?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants